home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / rcs5ap1b.lzh / CO.1LP < prev    next >
Text File  |  1991-01-30  |  18KB  |  463 lines
  1.  
  2.  
  3.  
  4. CO(1)                  Programmer's Manual                  CO(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      co - check out RCS revisions
  10.  
  11. SYNOPSIS
  12.      co [_✓o_✓p_✓t_✓i_✓o_✓n_✓s] _✓f_✓i_✓l_✓e ...
  13.  
  14. DESCRIPTION
  15.      co retrieves a revision from each RCS file and stores it
  16.      into the corresponding working file.  Each file name ending
  17.      in ,v is taken to be an RCS file; all other files are
  18.      assumed to be working files.  If only a working file is
  19.      given, co tries to find the corresponding RCS file in the
  20.      directory ./RCS and then in the current directory.  For more
  21.      details, see FILE NAMING below.
  22.  
  23.      Revisions of an RCS file may be checked out locked or
  24.      unlocked.  Locking a revision prevents overlapping updates.
  25.      A revision checked out for reading or processing (e.g., com-
  26.      piling) need not be locked.  A revision checked out for
  27.      editing and later checkin must normally be locked.  Checkout
  28.      with locking fails if the revision to be checked out is
  29.      currently locked by another user.  (A lock may be broken
  30.      with rcs(1).)  Checkout with locking also requires the
  31.      caller to be on the access list of the RCS file, unless he
  32.      is the owner of the file or the superuser, or the access
  33.      list is empty.  Checkout without locking is not subject to
  34.      accesslist restrictions, and is not affected by the presence
  35.      of locks.
  36.  
  37.      A revision is selected by options for revision or branch
  38.      number, checkin date/time, author, or state.  When the
  39.      selection options are applied in combination, co retrieves
  40.      the latest revision that satisfies all of them.  If none of
  41.      the selection options is specified, co retrieves the latest
  42.      revision on the default branch (normally the trunk, see the
  43.      -b option of rcs(1)).  A revision or branch number may be
  44.      attached to any of the options -f, -I, -l, -p, -q, -r, or
  45.      -u.  The options -d (date), -s (state), and -w (author)
  46.      retrieve from a single branch, the _✓s_✓e_✓l_✓e_✓c_✓t_✓e_✓d branch, which is
  47.      either specified by one of -f, ..., -u, or the default
  48.      branch.
  49.  
  50.      A co command applied to an RCS file with no revisions
  51.      creates a zero-length working file.  co always performs key-
  52.      word substitution (see below).
  53.  
  54. OPTIONS
  55.      -r[_✓r_✓e_✓v]
  56.           retrieves the latest revision whose number is less than
  57.           or equal to _✓r_✓e_✓v. If _✓r_✓e_✓v indicates a branch rather than
  58.           a revision, the latest revision on that branch is
  59.           retrieved.  If _✓r_✓e_✓v is omitted, the latest revision on
  60.  
  61.  
  62.  
  63. Printed 1/29/91            1990/12/04                           1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CO(1)                  Programmer's Manual                  CO(1)
  71.  
  72.  
  73.  
  74.           the default branch (see the -b option of rcs(1)) is
  75.           retrieved.  A revision is composed of one or more
  76.           numeric or symbolic fields separated by periods.  The
  77.           numeric equivalent of a symbolic field is specified
  78.           with the -n option of the commands ci(1) and rcs(1).
  79.  
  80.      -l[_✓r_✓e_✓v]
  81.           same as -r, except that it also locks the retrieved
  82.           revision for the caller.
  83.  
  84.      -u[_✓r_✓e_✓v]
  85.           same as -r, except that it unlocks the retrieved revi-
  86.           sion if it was locked by the caller.  If _✓r_✓e_✓v is omit-
  87.           ted, -u retrieves the latest revision locked by the
  88.           caller; if no such lock exists, it retrieves the latest
  89.           revision on the default branch.
  90.  
  91.      -f[_✓r_✓e_✓v]
  92.           forces the overwriting of the working file; useful in
  93.           connection with -q.  See also FILE MODES below.
  94.  
  95.      -kkv Generate keyword strings using the default form, e.g.
  96.           $Revision: 5.4 $ for the Revision keyword.  A locker's
  97.           name is inserted in the value of the Header, Id, and
  98.           Locker keyword strings only as a file is being locked,
  99.           i.e. by ci -l and co -l.  This is the default.
  100.  
  101.      -kkvl
  102.           Like -kkv, except that a locker's name is always
  103.           inserted if the given revision is currently locked.
  104.  
  105.      -kk  Generate only keyword names in keyword strings; omit
  106.           their values.  See KEYWORD SUBSTITUTION below.  For
  107.           example, for the Revision keyword, generate the string
  108.           $Revision$ instead of $Revision: 5.4 $.  This option is
  109.           useful to ignore differences due to keyword substitu-
  110.           tion when comparing different revisions of a file.
  111.  
  112.      -ko  Generate the old keyword string, present in the working
  113.           file just before it was checked in.  For example, for
  114.           the Revision keyword, generate the string $Revision:
  115.           1.1 $ instead of $Revision: 5.4 $ if that is how the
  116.           string appeared when the file was checked in.  This can
  117.           be useful for binary file formats that cannot tolerate
  118.           any changes to substrings that happen to take the form
  119.           of keyword strings.
  120.  
  121.      -kv  Generate only keyword values for keyword strings.  For
  122.           example, for the Revision keyword, generate the string
  123.           5.4 instead of $Revision: 5.4 $.  This can help gen-
  124.           erate files in programming languages where it is hard
  125.           to strip keyword delimiters like $Revision: $ from a
  126.  
  127.  
  128.  
  129. Printed 1/29/91            1990/12/04                           2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CO(1)                  Programmer's Manual                  CO(1)
  137.  
  138.  
  139.  
  140.           string.  However, further keyword substitution cannot
  141.           be performed once the keyword names are removed, so
  142.           this option should be used with care.  Because of this
  143.           danger of losing keywords, this option cannot be com-
  144.           bined with -l, and the owner write permission of the
  145.           working file is turned off; to edit the file later,
  146.           check it out again without -kv.
  147.  
  148.      -p[_✓r_✓e_✓v]
  149.           prints the retrieved revision on the standard output
  150.           rather than storing it in the working file.  This
  151.           option is useful when co is part of a pipe.
  152.  
  153.      -q[_✓r_✓e_✓v]
  154.           quiet mode; diagnostics are not printed.
  155.  
  156.      -I[_✓r_✓e_✓v]
  157.           interactive mode; the user is prompted and questioned
  158.           even if the standard input is not a terminal.
  159.  
  160.      -d_✓d_✓a_✓t_✓e
  161.           retrieves the latest revision on the selected branch
  162.           whose checkin date/time is less than or equal to _✓d_✓a_✓t_✓e.
  163.           The date and time may be given in free format.  The
  164.           time zone LT stands for local time; other common time
  165.           zone names are understood.  For example, the following
  166.           _✓d_✓a_✓t_✓es are equivalent if local time is January 11, 1990,
  167.           8pm Pacific Standard Time (eight hours west of GMT):
  168.  
  169.                8:00 pm lt
  170.                4:00 AM, Jan. 12, 1990           note: default is GMT
  171.                1990/01/12 04:00:00              RCS date format
  172.                Thu Jan 11 20:00:00 1990 LT      output of ctime(3) + LT
  173.                Thu Jan 11 20:00:00 PST 1990     output of date(1)
  174.                Fri Jan 12 04:00:00 GMT 1990
  175.                Thu, 11 Jan 1990 20:00:00 -0800
  176.                Fri-JST, 1990, 1pm Jan 12
  177.                12-January-1990, 04:00-WET
  178.  
  179.           Most fields in the date and time may be defaulted.  The
  180.           default time zone is GMT.  The other defaults are
  181.           determined in the order year, month, day, hour, minute,
  182.           and second (most to least significant).  At least one
  183.           of these fields must be provided.  For omitted fields
  184.           that are of higher significance than the highest pro-
  185.           vided field, the time zone's current values are
  186.           assumed.  For all other omitted fields, the lowest pos-
  187.           sible values are assumed.  For example, the date 20,
  188.           10:30 defaults to 10:30:00 GMT of the 20th of the GMT
  189.           time zone's current month and year.  The date/time must
  190.           be quoted if it contains spaces.
  191.  
  192.  
  193.  
  194.  
  195. Printed 1/29/91            1990/12/04                           3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CO(1)